home *** CD-ROM | disk | FTP | other *** search
/ MPEG Toolkit / MPEG Toolkit.iso / os2 / mpegenc / src / headers / frame.h < prev    next >
Encoding:
C/C++ Source or Header  |  1997-01-01  |  3.6 KB  |  111 lines
  1. /*===========================================================================*
  2.  * frame.h                                     *
  3.  *                                         *
  4.  *    basic frames procedures                             *
  5.  *                                         *
  6.  *===========================================================================*/
  7.  
  8. /*
  9.  * Copyright (c) 1993 The Regents of the University of California.
  10.  * All rights reserved.
  11.  *
  12.  * Permission to use, copy, modify, and distribute this software and its
  13.  * documentation for any purpose, without fee, and without written agreement is
  14.  * hereby granted, provided that the above copyright notice and the following
  15.  * two paragraphs appear in all copies of this software.
  16.  *
  17.  * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR
  18.  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
  19.  * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  20.  * CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  21.  *
  22.  * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  23.  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  24.  * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  25.  * ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  26.  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  27.  */
  28.  
  29.  
  30. #ifndef FRAME_INCLUDED
  31. #define FRAME_INCLUDED
  32.  
  33. /*==============*
  34.  * HEADER FILES *
  35.  *==============*/
  36.  
  37. #include <pbmplus.h>
  38. #include <pnm.h>
  39. #include "general.h"
  40. #include "ansi.h"
  41. #include "mtypes.h"
  42.  
  43.  
  44. /*===========*
  45.  * CONSTANTS *
  46.  *===========*/
  47. #define TYPE_IFRAME    2
  48. #define TYPE_PFRAME    3
  49. #define TYPE_BFRAME    4
  50.  
  51.  
  52. /*=======================*
  53.  * STRUCTURE DEFINITIONS *
  54.  *=======================*/
  55.  
  56. typedef struct mpegFrame {
  57.     int type;
  58.     char    inputFileName[256];
  59.     int id;           /* the frame number -- starts at 0 */
  60.     boolean inUse;    /* TRUE iff this frame is currently being used */
  61.             /* FALSE means any data here can be thrashed */
  62.  
  63.     uint8   **ppm_data;
  64.     xel **rgb_data;         /* pnm format -- see pbmplus docs */
  65.     xelval rgb_maxval;      /* largest value of any pixel index */
  66.     int rgb_format;         /* more info from pnm */
  67.  
  68.     /*  
  69.      *  now, the YCrCb data.  All pixel information is stored in unsigned
  70.      *  8-bit pieces.  We separate y, cr, and cb because cr and cb are
  71.      *  subsampled by a factor of 2.
  72.      */
  73.     uint8 **orig_y, **orig_cr, **orig_cb;
  74.  
  75.     /* now, the decoded data -- relevant only if
  76.      *        referenceFrame == DECODED_FRAME
  77.      *
  78.      */
  79.     uint8 **decoded_y, **decoded_cr, **decoded_cb;
  80.  
  81.     /* reference data */
  82.     uint8 **ref_y, **ref_cr, **ref_cb;
  83.  
  84.     /*  
  85.      *  these are the Blocks which will ultimately compose MacroBlocks.
  86.      *  A Block is in a format that mp_fwddct() can crunch.
  87.      */
  88.     Block **y_blocks, **cr_blocks, **cb_blocks;
  89.  
  90.     /*
  91.      *  this is the half-pixel luminance data (for reference frames)
  92.      */
  93.     uint8 **halfX, **halfY, **halfBoth;
  94.  
  95.     boolean   halfComputed;        /* TRUE iff half-pixels already computed */
  96. } MpegFrame;
  97.  
  98.  
  99. extern MpegFrame *Frame_New _ANSI_ARGS_((int id, int type));
  100. extern void      Frame_Init _ANSI_ARGS_((void));
  101. extern void      Frame_Free _ANSI_ARGS_((MpegFrame *frame));
  102. extern void      Frame_Exit _ANSI_ARGS_((void));
  103. extern void      Frame_AllocPPM _ANSI_ARGS_((MpegFrame * frame));
  104. extern void      Frame_AllocYCC _ANSI_ARGS_((MpegFrame * mf));
  105. extern void      Frame_AllocDecoded _ANSI_ARGS_((MpegFrame *frame,
  106.                           boolean makeReference));
  107. extern void      Frame_AllocHalf _ANSI_ARGS_((MpegFrame *frame));
  108. extern void      Frame_AllocBlocks _ANSI_ARGS_((MpegFrame *mf));
  109.  
  110. #endif /* FRAME_INCLUDED */
  111.